package org.larkdoc.dao;

import java.util.List;

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.larkdoc.model.bo.DocBO;
import org.larkdoc.model.entity.DocInfo;
import org.larkdoc.model.vo.DocVO;

/**
 * 文档信息Mapper接口类
 * 
 * @author  zhangpeijun[zhangpeijun1024@qq.com]
 * @version  [v1.0.1, 2017年10月17日]
 * @see  [相关类/方法]
 * @since  [产品/模块版本]
 */
@Mapper
public interface DocInfoMapper {
    /**
     * 根据ID删除数据
     * @param id
     * @return
     * 
     * @returns int
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:01:29
     */
    int deleteByPrimaryKey(Integer id);
    
    /**
     * 新增数据
     * @param record
     * @return
     * 
     * @returns int
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:05:40
     */
    int insert(DocInfo record);
    
    /**
     * 新增记录，只记录对象非空属性
     * @param record
     * @return
     * 
     * @returns int
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:10:42
     */
    int insertSelective(DocInfo record);
    
    /**
     * 根据ID查询数据
     * @param id
     * @return
     * 
     * @returns DocInfo
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:12:46
     */
    DocInfo selectByPrimaryKey(Integer id);
    
    /**
     * 根据ID更新记录，只更新参数中非空的属性
     * @param record
     * @return
     * 
     * @returns int
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:14:46
     */
    int updateByPrimaryKeySelective(DocInfo record);
    
    /**
     * 根据ID更新记录
     * @param record
     * @return
     * 
     * @returns int
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:18:41
     */
    int updateByPrimaryKey(DocInfo record);
    
    /*
     * 自定义SQL
     */
    
    /**
     * 根据ID获取用户可见文档：<br/>
     * 1、全量开放文档<br/>
     * 2、所属群主文档<br/>
     * 3、所属项目文档<br/>
     * @param id
     * @param account
     * @return [参数说明]
     * 
     * @return DocInfo [返回类型说明]
     * @exception throws [违例类型] [违例说明]
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年4月12日下午4:36:34
     */
    DocInfo getByIdAndAccount(@Param("id") Integer id, @Param("creator") String account);
    
    /**
     * 根据文档信息匹配记录
     * @param docInfo
     * @return
     * 
     * @returns List<DocInfo>
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:19:20
     */
    List<DocInfo> selectByDocInfo(DocInfo docInfo);
    
    /**
     * 根据文档VO查询记录
     * @param docVO
     * @return
     * 
     * @returns List<DocInfo>
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:19:52
     */
    List<DocInfo> selectByDocVO(DocVO docVO);
    
    /**
     * 检测文档是否存在
     * @param docInfo
     * @return
     * 
     * @returns int
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:20:13
     */
    int checkExists(DocInfo docInfo);
    
    /**
     * 根据文档VO查询数据返回DocBo
     * @param docVO
     * @return
     * 
     * @returns List<DocBO>
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:22:31
     */
    List<DocBO> queryByDocVO(DocVO docVO);
    
    /**
     * 根据文档id查询记录
     * @param id
     * @param account
     * @return
     * 
     * @returns DocBO
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:22:59
     */
    DocBO getAuthDocById(@Param("id") Integer id, @Param("creator") String account);
    
    /**
     * 根据文档ID和用户帐号删除文档
     * @param ids
     * @param account
     * @return
     * 
     * @returns int
     * @see [类、类#方法、类#成员]
     * @author  zhangpeijun[zhangpeijun1024@qq.com]<br/>
     *          2017年10月17日下午12:23:19
     */
    int deleteByIdsAndAccount(@Param("ids") int[] ids, @Param("account") String account);
    
    /**
     * 根据项目查询文档数据返回DocBo
     * @param docVO
     * @return
     * 
     * @returns List<DocBO>
     * @see [类、类#方法、类#成员]
     * @author  yangyongke[25278885@qq.com]<br/>
     *          2017年12月11日上午11:22:31
     */
    List<DocBO> queryByProject(DocVO docVO);
}